/*
 * Copyright (c) 2012 Jonathan Tyers
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package uk.org.uplink.configproxy.validator;

import uk.org.uplink.configproxy.MethodInfo;
import uk.org.uplink.configproxy.exception.InvalidConfigurationValueException;

/**
 * Validates values on behalf of a ConfigProxy.
 * 
 * @author jonny
 */
public interface ConfigProxyValidator {

	/**
	 * Validate that a value returned by a method is valid, and throw an exception if it is not.
	 * 
	 * @param methodInfo information about the method that was called to retrieve the value
	 * @param result the value to be validated (this is either the value for the key that was looked up, or the default value, or the value of the
	 * default key), which could be null
	 * 
	 * @throws InvalidConfigurationValueException if <tt>result</tt> is invalid
	 */
	void validate(final MethodInfo methodInfo, final Object result);

}